<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
<meta http-equiv="X-UA-Compatible" content="IE=9"/>
<meta name="generator" content="Doxygen 1.8.5"/>
<title>vprocss: system.c File Reference</title>
<link href="tabs.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="jquery.js"></script>
<script type="text/javascript" src="dynsections.js"></script>
<link href="navtree.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="resize.js"></script>
<script type="text/javascript" src="navtree.js"></script>
<script type="text/javascript">
  $(document).ready(initResizable);
  $(window).load(resizeHeight);
</script>
<link href="doxygen.css" rel="stylesheet" type="text/css" />
<link href="HTML_custom.css" rel="stylesheet" type="text/css"/>
</head>
<body>
<div id="top"><!-- do not remove this div, it is closed by doxygen! -->
<div id="titlearea">
<table cellspacing="0" cellpadding="0">
 <tbody>
 <tr style="height: 56px;">
  <td id="projectlogo"><img alt="Logo" src="xlogo_bg.png"/></td>
  <td style="padding-left: 0.5em;">
   <div id="projectname">vprocss
   </div>
   <div id="projectbrief">Vitis Drivers API Documentation</div>
  </td>
 </tr>
 </tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.8.5 -->
  <div id="navrow1" class="tabs">
    <ul class="tablist">
      <li><a href="index.html"><span>Overview</span></a></li>
      <li><a href="annotated.html"><span>Data&#160;Structures</span></a></li>
      <li><a href="globals.html"><span>APIs</span></a></li>
      <li><a href="files.html"><span>File&#160;List</span></a></li>
      <li><a href="pages.html"><span>Examples</span></a></li>
    </ul>
  </div>
</div><!-- top -->
<div id="side-nav" class="ui-resizable side-nav-resizable">
  <div id="nav-tree">
    <div id="nav-tree-contents">
      <div id="nav-sync" class="sync"></div>
    </div>
  </div>
  <div id="splitbar" style="-moz-user-select:none;" 
       class="ui-resizable-handle">
  </div>
</div>
<script type="text/javascript">
$(document).ready(function(){initNavTree('system_8c.html','');});
</script>
<div id="doc-content">
<div class="header">
  <div class="summary">
<a href="#func-members">Functions</a>  </div>
  <div class="headertitle">
<div class="title">system.c File Reference</div>  </div>
</div><!--header-->
<div class="contents">
<a name="details" id="details"></a><h2 class="groupheader">Overview</h2>
<div class="textblock"><p>This is top level resource file that will initialize all system level peripherals. </p>
<pre>
MODIFICATION HISTORY:</pre><pre>Ver   Who    Date     Changes
</p>
<hr/>
<p>
0.01  rc   07/07/14  First release
1.00  dmc  01/25/16  Initialize the VPSS Event Logging system in <a class="el" href="system_8c.html#adc710a6298515ea6e63a39567010bc75" title="This function is the system level initialization routine. ">XSys_Init()</a></pre><pre></pre> </div><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="func-members"></a>
Functions</h2></td></tr>
<tr class="memitem:adc710a6298515ea6e63a39567010bc75"><td class="memItemLeft" align="right" valign="top">int&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="system_8c.html#adc710a6298515ea6e63a39567010bc75">XSys_Init</a> (<a class="el" href="struct_x_periph.html">XPeriph</a> *pPeriph, <a class="el" href="struct_x_vproc_ss.html">XVprocSs</a> *pVprocss)</td></tr>
<tr class="memdesc:adc710a6298515ea6e63a39567010bc75"><td class="mdescLeft">&#160;</td><td class="mdescRight">This function is the system level initialization routine.  <a href="#adc710a6298515ea6e63a39567010bc75">More...</a><br/></td></tr>
<tr class="separator:adc710a6298515ea6e63a39567010bc75"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a8792e86d543723e45b05f863a9aeeea0"><td class="memItemLeft" align="right" valign="top">int&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="system_8c.html#a8792e86d543723e45b05f863a9aeeea0">XSys_SetStreamParam</a> (<a class="el" href="struct_x_vproc_ss.html">XVprocSs</a> *pVprocss, u16 Direction, u16 Width, u16 Height, XVidC_FrameRate FrameRate, XVidC_ColorFormat cfmt, u16 IsInterlaced)</td></tr>
<tr class="memdesc:a8792e86d543723e45b05f863a9aeeea0"><td class="mdescLeft">&#160;</td><td class="mdescRight">This function is to set vpss stream parameters.  <a href="#a8792e86d543723e45b05f863a9aeeea0">More...</a><br/></td></tr>
<tr class="separator:a8792e86d543723e45b05f863a9aeeea0"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a782ef0a1a4d351df9c125446c81dd1be"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="system_8c.html#a782ef0a1a4d351df9c125446c81dd1be">XSys_ReportSystemInfo</a> (<a class="el" href="struct_x_periph.html">XPeriph</a> *pPeriph, <a class="el" href="struct_x_vproc_ss.html">XVprocSs</a> *pVprocss)</td></tr>
<tr class="memdesc:a782ef0a1a4d351df9c125446c81dd1be"><td class="mdescLeft">&#160;</td><td class="mdescRight">This function reports all the IP's included in the system design.  <a href="#a782ef0a1a4d351df9c125446c81dd1be">More...</a><br/></td></tr>
<tr class="separator:a782ef0a1a4d351df9c125446c81dd1be"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table>
<h2 class="groupheader">Function Documentation</h2>
<a class="anchor" id="adc710a6298515ea6e63a39567010bc75"></a>
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">int XSys_Init </td>
          <td>(</td>
          <td class="paramtype"><a class="el" href="struct_x_periph.html">XPeriph</a> *&#160;</td>
          <td class="paramname"><em>pPeriph</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype"><a class="el" href="struct_x_vproc_ss.html">XVprocSs</a> *&#160;</td>
          <td class="paramname"><em>pVprocss</em>&#160;</td>
        </tr>
        <tr>
          <td></td>
          <td>)</td>
          <td></td><td></td>
        </tr>
      </table>
</div><div class="memdoc">

<p>This function is the system level initialization routine. </p>
<p>It in turn calls each of the included subsystem initialization function</p>
<dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramname">pPeriph</td><td>is a pointer to the peripherals instance </td></tr>
    <tr><td class="paramname">pVprocss</td><td>is a pointer to the video proc subsystem instance</td></tr>
  </table>
  </dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd><ul>
<li>XST_SUCCESS if init. was successful.</li>
<li>XST_FAILURE if init. was unsuccessful.</li>
</ul>
</dd></dl>
<dl class="section note"><dt>Note</dt><dd>None. </dd></dl>

<p>References <a class="el" href="struct_x_vproc_ss___config.html#af561818387a2c40b466a1884faeb3310">XVprocSs_Config::BaseAddress</a>, <a class="el" href="struct_x_vproc_ss___config.html#a53b84d342e901571eeecbd899d51b8f3">XVprocSs_Config::Topology</a>, <a class="el" href="periph_8c.html#acf9db5b3ae03d0367de50a8cf1926421">XPeriph_PowerOnInit()</a>, <a class="el" href="xvprocss_8c.html#aac138624e6b5449040be8bd02710a512">XVprocSs_CfgInitialize()</a>, <a class="el" href="xvprocss_8h.html#a7bde6b4ee20f3546da3db9c8b3295d59">XVprocSs_LogReset()</a>, <a class="el" href="group__vprocss.html#gae1122f4587efc719f26e180560081e55">XVprocSs_LookupConfig()</a>, and <a class="el" href="xvprocss_8c.html#a650457b5f1b57842c2e3edd06d1de480">XVprocSs_SetFrameBufBaseaddr()</a>.</p>

</div>
</div>
<a class="anchor" id="a782ef0a1a4d351df9c125446c81dd1be"></a>
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">void XSys_ReportSystemInfo </td>
          <td>(</td>
          <td class="paramtype"><a class="el" href="struct_x_periph.html">XPeriph</a> *&#160;</td>
          <td class="paramname"><em>pPeriph</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype"><a class="el" href="struct_x_vproc_ss.html">XVprocSs</a> *&#160;</td>
          <td class="paramname"><em>pVprocss</em>&#160;</td>
        </tr>
        <tr>
          <td></td>
          <td>)</td>
          <td></td><td></td>
        </tr>
      </table>
</div><div class="memdoc">

<p>This function reports all the IP's included in the system design. </p>
<p>It calls each subsystem API to report its child nodes</p>
<dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramname">pPeriph</td><td>is a pointer to the peripherals instance </td></tr>
    <tr><td class="paramname">pVprocss</td><td>is a pointer to the video proc subsystem instance</td></tr>
  </table>
  </dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>None</dd></dl>
<dl class="section note"><dt>Note</dt><dd>None. </dd></dl>

<p>References <a class="el" href="periph_8c.html#a031f74192dd2f5bc81a370043141d63d">XPeriph_ReportDeviceInfo()</a>, and <a class="el" href="xvprocss_8c.html#af3ef2fc6d79df8ccb528644f8e539828">XVprocSs_ReportSubsystemCoreInfo()</a>.</p>

</div>
</div>
<a class="anchor" id="a8792e86d543723e45b05f863a9aeeea0"></a>
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">int XSys_SetStreamParam </td>
          <td>(</td>
          <td class="paramtype"><a class="el" href="struct_x_vproc_ss.html">XVprocSs</a> *&#160;</td>
          <td class="paramname"><em>pVprocss</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">u16&#160;</td>
          <td class="paramname"><em>Direction</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">u16&#160;</td>
          <td class="paramname"><em>Width</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">u16&#160;</td>
          <td class="paramname"><em>Height</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">XVidC_FrameRate&#160;</td>
          <td class="paramname"><em>FrameRate</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">XVidC_ColorFormat&#160;</td>
          <td class="paramname"><em>cfmt</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">u16&#160;</td>
          <td class="paramname"><em>IsInterlaced</em>&#160;</td>
        </tr>
        <tr>
          <td></td>
          <td>)</td>
          <td></td><td></td>
        </tr>
      </table>
</div><div class="memdoc">

<p>This function is to set vpss stream parameters. </p>
<dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramname">pVprocss</td><td>is a pointer to the video proc subsystem instance </td></tr>
    <tr><td class="paramname">Direction</td><td>defined if parameters are to be applied to Input or output stream </td></tr>
    <tr><td class="paramname">Width</td><td>is stream width </td></tr>
    <tr><td class="paramname">Height</td><td>is stream height </td></tr>
    <tr><td class="paramname">FrameRate</td><td>is stream frame rate </td></tr>
    <tr><td class="paramname">cfmt</td><td>is stream color format</td></tr>
  </table>
  </dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>XST_SUCCESS - if the stream configuration is proper XST_INVALID_PARAM - if the stream configuration is not proper</dd></dl>
<dl class="section note"><dt>Note</dt><dd>None. </dd></dl>

<p>References <a class="el" href="struct_x_vproc_ss___config.html#adc152d18753ba8d8ccc8a84e88008124">XVprocSs_Config::ColorDepth</a>, <a class="el" href="struct_x_vproc_ss.html#a63bcaaaf281c28f90fb0ca06167cb658">XVprocSs::Config</a>, <a class="el" href="struct_x_vproc_ss___config.html#ab49aa8f927f6858960fddc1c3bcdc997">XVprocSs_Config::PixPerClock</a>, <a class="el" href="xvprocss_8c.html#a47c310a89b7072313404485d4bb9b03f">XVprocSs_SetVidStreamIn()</a>, and <a class="el" href="xvprocss_8c.html#a28fae690c023b4d8b7a1d9b9c68c966c">XVprocSs_SetVidStreamOut()</a>.</p>

</div>
</div>
</div><!-- contents -->
</div><!-- doc-content -->
<div id="nav-path" class="navpath"><!-- id is needed for treeview function! -->
	<p class="footer">&copy; Copyright 2015-2022 Xilinx, Inc. All Rights Reserved.</p>
	<p class="footer">&copy; Copyright 2022-2023 Advanced Micro Devices, Inc. All Rights Reserved.</p>
</div>
</body>
</html>
